package com.zhixing.controller;

import org.springframework.ui.Model;

import javax.servlet.http.HttpServletResponse;

/**
 * swagger 2 word API
 *
 * 接口定义
 * @author zhixing
 */
public interface ISwagger2WordProcessor {

    /**
     * Swagger 文档转后在线预览文件，可以通过右键另存为 xxx.doc 的方式另存为 word 文档
     * @param model 模板数据
     * @param url  swagger 地址
     * @return
     */
    public String getWord(Model model,String url,String tags);

    /**
     * 将 swagger 文档一键下载为 doc 文档（所有数据）
     *
     * @param model
     * @param url      需要转换成 word 文档的资源地址
     * @param response
     */
    void word(Model model, String url, String fileName, String tags, HttpServletResponse response);
}
